[TSD] Add FEATURES[‘ENABLE_EDXNOTES’] documentation - #26203
Conversation
openedx-webhooks
added
needs triage
open-source-contribution
|
Thanks for the pull request, @NeOneSoft! I've created OSPR-5572 to keep track of it in JIRA, where we prioritize reviews. Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. |
|
@NeOneSoft Thank you! @robrap FYI |
| # .. toggle_description: The edxnotes app is responsible for displaying parts of the Notes UI to students in different parts | ||
| # of the LMS, as well as figuring out whether Notes is enabled for a particular situation. The bulk of the actual work in | ||
| # storing the notes is done by a separate service (see the edx-notes-api repo). | ||
| # .. toggle_warnings: Requires the edx-notes-api service properly running and to have configured the django settings as well |
There was a problem hiding this comment.
Could you specify which are those settings? So far, I think that they are EDXNOTES_INTERNAL_API and EDXNOTES_INTERNAL_API
There was a problem hiding this comment.
Thank you @morenol!!. Great I think EDXNOTES_INTERNAL_API and EDXNOTES_PUBLIC_API am I right?!
robrap
left a comment
robrap
left a comment
There was a problem hiding this comment.
Great. Thank you so much for writing this up. I dropped a bunch of minor comments.
| # .. toggle_warnings: Requires the edx-notes-api service properly running and to have configured the django settings | ||
| # EDXNOTES_INTERNAL_API and EDXNOTES_PUBLIC_API | ||
| # .. toggle_use_cases: open_edx | ||
| # .. toggle_creation_date: None |
There was a problem hiding this comment.
Should be 2015-01-04. See https://github.com/edx/edx-platform/pull/6321/files
| # EDXNOTES_INTERNAL_API and EDXNOTES_PUBLIC_API | ||
| # .. toggle_use_cases: open_edx | ||
| # .. toggle_creation_date: None | ||
| # .. toggle_tickets: None |
There was a problem hiding this comment.
Could use the PR mentioned above: https://github.com/edx/edx-platform/pull/6321
| # course using the notes service. The bulk of the actual work in storing the notes is done by | ||
| # by a separate service(see the edx-notes-api repo). | ||
| # .. toggle_warnings: Requires the edx-notes-api service properly running and to have configured the django settings | ||
| # EDXNOTES_INTERNAL_API and EDXNOTES_PUBLIC_API |
There was a problem hiding this comment.
Do you mind adding a warning to keep this in sync with Studio?
| # EDXNOTES_INTERNAL_API and EDXNOTES_PUBLIC_API | |
| # EDXNOTES_INTERNAL_API and EDXNOTES_PUBLIC_API. If you update this setting, also update in Studio. |
Additionally, you could replace three lines of comments in cms here: https://github.com/edx/edx-platform/blob/2d7a8358efe563b6e1968f56229e4f72c9740857/cms/envs/common.py#L228-L231 with something like the following:
# See LMS annotations for details.
| @@ -434,6 +434,17 @@ | |||
| 'ENABLE_FOOTER_MOBILE_APP_LINKS': False, | |||
|
|
|||
| # Let students save and manage their annotations | |||
There was a problem hiding this comment.
You can delete this line. It is no longer needed now that we have this annotated.
|
@robrap Thank you for your comments!I'll be updating them and attending any other suggestion! |
|
Your PR has finished running tests. There were no failures. |
|
@NeOneSoft Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future. |
|
PR closed on behalf of https://github.com/edx/edx-platform/pull/26256 |
6 participants
Description
Add FEATURES[‘ENABLE_EDXNOTES’] documentation has the purpose to give some information about annotations
related with that feature toggle. This documentation does not affect the behavior of the feature and only has
useful information for edX community.
Reference:
https://openedx.atlassian.net/wiki/spaces/OpenOPS/pages/26182212/How+to+Get+edX+Notes+Running
https://blog.lawrencemcdaniel.com/open-edx-notes/